There are several fields in the Pricing Search that can be used to adjust the rates returned.

• MultiCriteriaSearchModel:
  • rate   
  • rateRange
• Search:
  • rates
• BrokerCriteria:
  • rateTypes
  • subRateTypes

The most important and commonly used of these are rateRange and rateTypes.

 

Setting Rate Values

You can search for specific rates by specifying a rate range, single rate, or multiple rates.

Use the BrokerCriteria.rate variable to filter for a single APR rate, such as 3.5%.

Use the Search.rates variable to search for multiple discrete APR rates, such as 2%, 3%, 3.5%. 

The MultiCrtieriaSearchModel.rateRange object contains fields that allow you to specify a starting and ending value for a range of rates. These values are stored in the fields, to and from.

Prioritization

If rate values are populated in multiple fields, the order of prioritization is such: rateRange takes the highest priority, followed by values in rates, and finally the value set in rate. For example, if the request contains the following values:

"rates": [2.5, 2.6],

"rate": 2.5

the request will search for rates at both 2.5 and 2.6.

If there is a value set for rateRange:

"rateRange": {

  "to": 2.5,

  "from": 2.6

}

the request will search for all rates from 2.5 to 2.6, inclusive.

 

Rate Types           

The rate types are broad categories for rates that can be applied to narrow your search. It is not required to specify this.

Rate Types:

All	Returns all rate types.
ForBroker	Returns the broker rate.
ForCorresponding	Returns the corresponding rate.
ForWholesale	Returns the wholesale rate.
AsRetail	Returns the retail rate.

Rate types are set using BrokerCriteria.rateTypes.